﻿//-----------------------------------------------------------------------
// <copyright file="MessageChannel.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace TileTool.Message
{
    /// <summary>
    /// A message channel is a unique identifier used in the messaging system
    /// to facilitate message filtering.
    /// 
    /// A message channel allows messages to be sent only to recipients who
    /// have requested to receive the messages only on a particular channel.
    /// //
    /// Regardless of channel, all messages will always be broadcast to the
    /// global channel.
    /// </summary>
    public class MessageChannel
    {
        /// <summary>
        /// Global message channel.
        /// </summary>
        private static MessageChannel global = Create();

        /// <summary>
        /// Gets the global message channel.
        /// </summary>
        public static MessageChannel Global
        {
            get
            {
                return global;
            }
        }

        /// <summary>
        /// Create a new unique message channel and return it.
        /// </summary>
        /// <returns>Returns a new message channel.</returns>
        public static MessageChannel Create()
        {
            return new MessageChannel();
        }
    }
}
